<!DOCTYPE html>
<html lang="fr">
	<head>
		<meta charset="utf-8" />
		<base href="../../../" />
		<script src="page.js"></script>
		<link type="text/css" rel="stylesheet" href="page.css" />
	</head>
	<body>
		[page:Object3D] &rarr;

		<h1>[name]</h1>

		<p class="desc">
			Crée un objet audio non-positionnel ( global ).<br /><br />

			La [link:https://developer.mozilla.org/en-US/docs/Web/API/Web_Audio_API Web Audio API] est utilisée.
		</p>

		<h2>Exemple de Code</h2>

		<code>
		// create an AudioListener and add it to the camera
		const listener = new THREE.AudioListener();
		camera.add( listener );

		// create a global audio source
		const sound = new THREE.Audio( listener );

		// load a sound and set it as the Audio object's buffer
		const audioLoader = new THREE.AudioLoader();
		audioLoader.load( 'sounds/ambient.ogg', function( buffer ) {
			sound.setBuffer( buffer );
			sound.setLoop( true );
			sound.setVolume( 0.5 );
			sound.play();
		});
		</code>

		<h2>Exemples</h2>

		<p>
			[example:webaudio_sandbox webaudio / sandbox ]<br />
			[example:webaudio_visualizer webaudio / visualizer ]
		</p>

		<h2>Constructeur</h2>


		<h3>[name]( [param:AudioListener listener] )</h3>
		<p>
		listener — (requis) instance d'[page:AudioListener AudioListener].
		</p>


		<h2>Propriétés</h2>

		<h3>[property:Boolean autoplay]</h3>
		<p>Démarrage automatique de la lecture. La valeur par défaut est `false`.</p>

		<h3>[property:AudioContext context]</h3>
		<p>L'[link:https://developer.mozilla.org/en-US/docs/Web/API/AudioContext AudioContext] du [page:AudioListener listener] passé au constructeur.</p>

		<h3>[property:Number detune]</h3>
		<p>Modifie le ton, mesuré en centaines. +/- 100 est un demi-ton. +/- 1200 est un octave. La valeur par défaut est `0`.</p>

		<h3>[property:Array filters]</h3>
		<p>Représente un tableau d'[link:https://developer.mozilla.org/en-US/docs/Web/API/AudioNode AudioNodes]. Peut être utilisé pour appliquer une variété de filtres d'ordres inférieurs pour créer des effets sonores complexes.
			Dans la plupart des cas, le tableau contient des instances de [link:https://developer.mozilla.org/en-US/docs/Web/API/BiquadFilterNode BiquadFilterNodes]. Les filtres sont appliqués via [page:Audio.setFilter] ou [page:Audio.setFilters].</p>

		<h3>[property:GainNode gain]</h3>
		<p>Un [link:https://developer.mozilla.org/en-US/docs/Web/API/GainNode GainNode] créé
		en utilisant [link:https://developer.mozilla.org/en-US/docs/Web/API/AudioContext/createGain AudioContext.createGain]().</p>

		<h3>[property:Boolean hasPlaybackControl]</h3>
		<p>Définit si la lecture peut-être contrôlée en utilisant les méthodes [page:Audio.play play](),
			[page:Audio.pause pause]() etc. La valeur par défaut est `true`.</p>

		<h3>[property:Boolean isPlaying]</h3>
		<p>Indique si l'audio est en cours de lecture.</p>

		<h3>[property:AudioListener listener]</h3>
		<p>Une reference à l'objet listener de cet audio.</p>

		<h3>[property:Number playbackRate]</h3>
		<p>Vitesse de lecture. La valeur par défaut est `1`.</p>

		<h3>[property:Number offset]</h3>
		<p>Un décalage temporel après lequel la lecture doit commencer. Équivalent au paramètre `offset` de [link:https://developer.mozilla.org/en-US/docs/Web/API/AudioBufferSourceNode/start AudioBufferSourceNode.start](). La valeur par défaut est `0`.</p>

		<h3>[property:Number duration]</h3>
		<p>Écrase la durée de l'audio. Équivalent au paramètre `duration` de [link:https://developer.mozilla.org/en-US/docs/Web/API/AudioBufferSourceNode/start AudioBufferSourceNode.start](). La valeur par défaut est `undefined` afin de jour le buffer entier.</p>

		<h3>[property:AudioNode source]</h3>
		<p>Un [link:https://developer.mozilla.org/en-US/docs/Web/API/AudioBufferSourceNode AudioBufferSourceNode] créé
		en utilisant [link:https://developer.mozilla.org/en-US/docs/Web/API/AudioContext/createBufferSource AudioContext.createBufferSource]().</p>

		<h3>[property:String sourceType]</h3>
		<p>Type de source audio. La valeur par défaut est 'empty'.</p>

		<h3>[property:String type]</h3>
		<p>String indiquant le type, contenant 'Audio'.</p>


		<h2>Méthodes</h2>

		<h3>[method:this connect]()</h3>
		<p>
		Connecte à la [page:Audio.source] audio. Ceci est utilisé en interne à l'initialisation et lors
		de l'ajout/retrait de filtres.
		</p>

		<h3>[method:this disconnect]()</h3>
		<p>
		Déconnecte de la [page:Audio.source]. Ceci est utilisé en interne lors
		de l'ajout/retrait de filtres.
		</p>

		<h3>[method:Float getDetune]()</h3>
		<p>
		Renvoie le detuning de l'oscillation en centaines.
		</p>

		<h3>[method:BiquadFilterNode getFilter]()</h3>
		<p>
		Renvoie le premier élément du tableau [page:Audio.filters filters].
		</p>

		<h3>[method:Array getFilters]()</h3>
		<p>
		Renvoie le tableau [page:Audio.filters filters].
		</p>

		<h3>[method:Boolean getLoop]()</h3>
		<p>
		Renvoie la valeur de [link:https://developer.mozilla.org/en-US/docs/Web/API/AudioBufferSourceNode/loop source.loop]
		 (Indique si la lecture doit boucler).
		</p>

		<h3>[method:GainNode getOutput]()</h3>
		<p>
		Renvoie le [page:Audio.gain gainNode].
		</p>

		<h3>[method:Float getPlaybackRate]()</h3>
		<p>
		Renvoie la valeur de [page:Audio.playbackRate playbackRate].
		</p>

		<h3>[method:Float getVolume]()</h3>
		<p>
		Renvoie le volume actuel.
		</p>

		<h3>[method:this play]( delay )</h3>
		<p>
		Si [page:Audio.hasPlaybackControl hasPlaybackControl] est à true, la lecture se lance.
		</p>

		<h3>[method:this pause]()</h3>
		<p>
		Si [page:Audio.hasPlaybackControl hasPlaybackControl] est à  true, la lecture se met en pause.
		</p>

		<h3>[method:undefined onEnded]()</h3>
		<p>
		Appelée automatiquement quand la lecture est terminée.
		</p>

		<h3>[method:this setBuffer]( audioBuffer )</h3>
		<p>
		Met la [page:Audio.source source] à audioBuffer, et met le [page:Audio.sourceType sourceType] à 'buffer'.<br />
		Si [page:Audio.autoplay autoplay] est activé, la méthode démarrera également la lecture.
		</p>

		<h3>[method:this setDetune]( [param:Float value] )</h3>
		<p>
		Définit le detuning de l'oscillation en centaines.
		</p>

		<h3>[method:this setFilter]( filter )</h3>
		<p>
		Applique un noeud à filtre unique à l'audio.
		</p>

		<h3>[method:this setFilters]( [param:Array value] )</h3>
		<p>
		value - tableau de filtres.<br />
		Applique un tableau de noeuds de filtres à l'audio.
		</p>

		<h3>[method:this setLoop]( [param:Boolean value] )</h3>
		<p>
		Met [link:https://developer.mozilla.org/en-US/docs/Web/API/AudioBufferSourceNode/loop source.loop] à `value`
		(Indique si la lecture doit boucler).
		</p>

		<h3>[method:this setLoopStart]( [param:Float value] )</h3>
		<p>
		Met [link:https://developer.mozilla.org/en-US/docs/Web/API/AudioBufferSourceNode/loopStart source.loopStart] à `value`.
		</p>

		<h3>[method:this setLoopEnd]( [param:Float value] )</h3>
		<p>
		Met [link:https://developer.mozilla.org/en-US/docs/Web/API/AudioBufferSourceNode/loopEnd source.loopEnd] à `value`.
		</p>

		<h3>[method:this setMediaElementSource]( mediaElement )</h3>
		<p>
		Définit le type d'objet passé en paramètre [link:https://developer.mozilla.org/en-US/docs/Web/API/HTMLMediaElement HTMLMediaElement] comme source de l'audio.<br />
		Met également [page:Audio.hasPlaybackControl hasPlaybackControl] à false.
		</p>

		<h3>[method:this setMediaStreamSource]( mediaStream )</h3>
		<p>
		Définit le type d'objet passé en paramètre [link:https://developer.mozilla.org/en-US/docs/Web/API/MediaStream MediaStream] comme source de l'audio.<br />
		Met également [page:Audio.hasPlaybackControl hasPlaybackControl] à false.
		</p>

		<h3>[method:this setNodeSource]( audioNode )</h3>
		<p>
		Met la [page:Audio.source source] à audioBuffer, et met le [page:Audio.sourceType sourceType] à 'audioNode'.<br />
		Met également [page:Audio.hasPlaybackControl hasPlaybackControl] à false.

		</p>

		<h3>[method:this setPlaybackRate]( [param:Float value] )</h3>
		<p>
		Si [page:Audio.hasPlaybackControl hasPlaybackControl] est activé, mets le [page:Audio.playbackRate playbackRate] à `value`.
		</p>

		<h3>[method:this setVolume]( [param:Float value] )</h3>
		<p>
		Modifie le volume.
		</p>

		<h3>[method:this stop]()</h3>
		<p>
		Si [page:Audio.hasPlaybackControl hasPlaybackControl] est activé, la lecture est stoppée.
		</p>

		<h2>Source</h2>

		<p>
			[link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]
		</p>
	</body>
</html>
